Publier une fiche Rzine

Processus de rédaction, soumission et relecture d’une fiche Rzine

Comité éditorial Rzine featured

1 Une fiche Rzine ?

La “fiche” est le premier format de documentation de la collection Rzine. Il s’agit d’un document didactique qui présente une méthodologie, un type d’analyse, une fonctionnalité, ou encore le traitement d’un certain type de données avec le langage R. Une fiche peut être principalement technique, méthodologique ou thématique, mais elle peut aussi couvrir ces trois aspects. Le premier objectif d’une fiche consiste à partager de manière pédagogique des méthodes reproductibles, applicables en SHS.

La publication de fiche est ouverte à tou·te·s, quels que soient son statut et sa discipline. Une fiche peut être réalisée à plusieurs et présenter une dimension interdisciplinaire.

Les auteur·e·s sont libres dans le choix de la problématique et dans la façon d’articuler le contenu. Il est cependant indispensable que le contenu d’une fiche soit correctement contextualisé et qu’il soit intelligible par l’ensemble des disciplines de SHS. Il est également obligatoire de suivre les règles suivantes :

  • Utiliser le modèle de mise en page readrzine
  • Rédiger en français ou en anglais
  • Introduire et contextualiser le contenu
  • Présenter du code entièrement reproductible
  • Utiliser des données libres d’utilisation et mises à disposition des lecteurs
  • Fournir les fichiers et annexes demandées

Vous pouvez consulter les premières fiches déjà produites pour vous faire une idée du résultat attendu :

Rzine souhaite promouvoir l’usage de logiciels contribuant à une science plus ouverte et reproductible, et participer à une montée en compétence des disciplines de SHS dans ce domaine. C’est pour cela que l’ensemble du processus d’évaluation se déroule sur GitHub (service web d’hébergement et de gestion de développement de logiciels) qui repose sur le logiciel de gestion de versions Git.


1.1 Critères d’acceptation

Afin d’assurer la cohérence de la collection et une certaine qualité du contenu des fiches Rzine, plusieurs critères d’acceptation ont été définis. Certains de ces critères peuvent faire l’objet d’un refus immédiat du comité de lecture, d’autres sont soumis à plusieurs évaluateur·rice·s.

Les éditeur·rice·s et les évaluateur·rice·s veilleront à ce que la démonstration soit contextualisée (champ disciplinaire d’application, enjeux en terme de reproductibilité…) et rigoureuse. Le code présenté se doit d’être lisible, commenté et reproductible. Les packages mobilisés doivent être brièvement décrits et leur utilisation justifiée. Enfin, les données utilisées dans le cadre de la démonstration doivent obligatoirement être sourcées, libres de droit et mises à disposition.

Critères d’évaluations d’une fiche Editeur·rice·s Evaluateur·rice·s
Respect des consignes éditoriales (partie 4) X
Acceptation des futures conditions d’utilisation (partie 1.4) X
Pas de fiche Rzine similaire déjà produite* X
N’a pas fait l’objet d’une publication par ailleurs X
Pas de renvoi publicitaire explicite X X
Respect du règlement général sur la protection des données (RGPD) X X
Intérêt pour la communauté des utilisateurs de R en SHS X X
Données utilisées libres, sourcées et mises à disposition (partie 4.2) X X
Rédaction dans un français ou un anglais correct X
Méthodes applicables en SHS (et sciences territoriales) X
Contextualisation de l’analyse ou méthode présentée (partie 4.3) X
Présentation des prérequis techniques et méthodologiques X
Clarté et rigueur de la ressource et de la démonstration X
Clarté (indentation, commentaire…) et reproductibilité du code présenté X X
Justification (et stabilité) des packages utilisés X X

*Le cas échéant, le comité de lecture se réserve la possibilité de mettre en relation différents contributeur.rice.s pour leur proposer un travail collaboratif.


1.2 Format et template

Une fiche Rzine est la sortie HTML d’un fichier R Markdown construit avec R. Les packages nécessaires sont rmarkdown, knitr (pour la compilation) et rzine (pour le modèle de mise en page).

Il s’agit d’un document computationnel, alternant du texte et du code, permettant d’appliquer le paradigme de la programmation lettrée.


1.3 Soumission et évaluation

L’ensemble du processus de soumission et d’évaluation d’une fiche se déroule sur GitHub. Cela facilite la gestion de version, permet l’archivage et la transparence du processus.

Pour être soumise à évaluation, une fiche doit être déposée et déployée sur GitHub (cf. partie 5).

Dans le cas où l’ensemble des critères d’acceptations sont respectés, le comité de lecture désigne un·e éditeur·rice référent·e qui coordonnera tout le processus d’évaluation et de publication. Il propose également deux évaluateur·rice·s à l’auteur·e. Une fois le processus d’évaluation enclenché, les retours des évaluateur·rice·s et de l’éditeur·rice se feront publiquement sur GitHub (cf. partie 6).


Le processus d’évaluation et de publication d’une fiche Rzine :



1.4 Publication et licence d’utilisation

Le projet Rzine souhaite promouvoir les pratiques contribuant à une science plus ouverte et reproductible. C’est pour cette raison que l’ensemble des publications de la collection Rzine, ainsi que leurs codes sources, sont automatiquement mis à disposition de tou·te·s et libres de droit.

2 Le package rzine

Le package rzine fournit le modèle de mise en page des fiches Rzine, ainsi que l’architecture de répertoire et l’ensemble des fichiers associés nécessaires.

2.1 Installation du package rzine

Le package est mis à disposition sur un dépôt de l’organisation Rzine sur l’instance GitLab de la TGIR Huma-num. Pour l’installer et le charger :

# install.packages(remotes)
remotes::install_gitlab("rzine/package", host = "https://gitlab.huma-num.fr/", force = TRUE)
library(rzine)

2.2 Utiliser le template readrzine

2.2.1 Spécifier un répertoire de travail

Avant de générer une fiche Rzine vierge il est important de spécifier un répertoire de travail. Pour cela, deux solutions s’offrent à vous :

1. En ligne de code

Créez un répertoire sur votre ordinateur et spécifiez-le comme répertoire de travail avec la fonction setwd() :

setwd("/home/jeanne/Documents/Fiche_rzine")

2. En clic-bouton avec Rstudio (recommandé)

Pour créer un projet Rstudio, cliquez sur File/New Project, sélectionnez New Directory, puis New Project :



2.2.2 Générer une fiche vierge (.Rmd)

Une fois dans votre projet Rstudio (ou bien que le répertoire de travail a été spécifié), vous pouvez générer un modèle de mise en page readrzine vierge en ligne de commande. Copiez-collez les lignes de code suivantes sans les modifier, puis exécutez :

rmarkdown::draft(file = "index.Rmd", 
                 template = "readrzine", 
                 package = "rzine", 
                 create_dir = FALSE, 
                 edit = FALSE)

Cela génère un ensemble de fichiers à la racine de votre répertoire de travail. Certains fichiers sont à modifier ou à ajouter en fonction du contenu de votre fiche :


2.3 Kniter la fiche (.html)

Pour générer la fiche en format HTML, il suffit de kniter (tricoter) le fichier index.Rmd.

Bien que cela soit invisible pour l’utilisateur, le fichier est d’abord converti en format Markdown puis en format HTML via Pandoc (logiciel libre de conversion de documents). Sur certaines versions de systèmes d’exploitation, le logiciel Pandoc n’est pas automatiquement disponible. Il est donc parfois nécessaire de l’installer.

Vous pouvez kniter le fichier index.Rmd de différentes manières :

1- En ligne de code

rmarkdown::render("index.Rmd", envir = new.env())

2- En clic-bouton (Rstudio)

3- Avec le raccourci clavier (Rstudio) :

  • PC : CTRL + SHIFT + K,
  • Mac : Command + Shift + K.


Un fichier du même nom en format HTML est alors créé à la racine de votre répertoire (index.html). Il s’agit du fichier index.Rmd mis en page à partir du modèle readrzine :

Il ne reste plus qu’à le remplir…


3 Anatomie d’un R Markdown

Bien que dans le cadre d’une publication Rzine certaines métadonnées et informations sont à renseigner et que certaines règles de mise en page doivent être appliquées, le modèle de mise en page readrzine fonctionne comme n’importe quel autre fichier R Markdown.

3.1 L’en-tête

L’en-tête d’un document R Markdown (parfois appelé YAML header) est délimité par deux lignes de trois tirets et contient des métadonnées et les éléments de style du document. Voici à quoi ressemble par exemple l’en-tête vierge du template readrzine :

---
title: "Titre fiche"
subtitle: "Sous-titre fiche"
date: "2022-01-20"
author: 
 - name: Premier Auteur.e
   affiliation: Affiliation_1, Affiliation_2
 - name: Second Auteur.e
   affiliation: Affiliation_1, Affiliation_2
image: "featured.png"   
logo: "figures/rzine.png"  
output:
  rzine::readrzine:
    highlight: kate
    number_sections: true
csl: Rzine_citation.csl
bibliography: biblio.bib
nocite: |
  @*
link-citations: true
# github: "author/repository"
# gitlab: "gitlab.huma-num.fr/author/repository"
# doi: "xx.xxx/xxxx.xxxxxxx"
# licence: "by-sa"

# Only Creative Commons Licence 
# 5 possible choices : "by-nd", "by", "by-nc-sa", "by-nc","by-sa"
---
  
  
  

3.2 Le texte balisé en markdown

Le corps d’un document R Markdown comprend deux types de contenu, que l’on peut librement alterner :

  • Des blocs de texte brut mis en forme selon la syntaxe Markdown ;
  • Des blocs de code, appelés chunks (cf. partie 3.3).

Le corps du document est constitué de texte mis en forme à l’aide de la syntaxe Markdown. Le Markdown est un langage de balisage léger et très facile à maîtriser, qui permet la mise en forme basique du texte.

Par exemple, le texte (brut) suivant :

Ceci est du texte en *italique*, **gras** ou en ***gras italique***.

Pour définir des listes à puces, utilisez les **tirets** :

- premier élément
- second élément

Vous pouvez également ajouter des [liens cliquables](https://rzine.fr/) 

Sera mis en page de la manière suivante dans le fichier HTML généré :

Ceci est du texte en italique, gras ou en gras italique.

Pour définir des listes à puces, utilisez les tirets :

  • premier élément
  • second élément

Vous pouvez également ajouter des liens cliquables

3.3 Les chunks

En plus du texte libre balisé en markdown, un document R Markdown peut évidemment contenir du code R.
Celui-ci doit être inclus dans des chunks délimités par la syntaxe suivante :

```{r}

x <- 37 + 12
print(x)

```

Pour insérer facilement un nouveau chunk, vous pouvez utiliser le menu Insert proposé par l’interface de développement RStudio, situé en haut à droite de l’éditeur de texte (à gauche du bouton Run) :

Vous pouvez également utiliser le raccourci clavier Ctrl + Alt + i ou Command + Option + I pour générer un chunk vide.

3.3.1 Nom et options

Vous pouvez nommer chaque chunk de la manière suivante :

```{r nom_du_chunck}

```

Un nom de chunk doit être unique. Il n’est pas obligatoire de nommer un chunk, mais cela peut être utile pour localiser une erreur lors de la compilation du code.

Des options peuvent être ajoutées sous la forme option = valeur. Elles permettent de paramétrer le comportement d’un chunk lors d’un knit (compilation du document). Exemple :

```{r nom_du_chunck, echo = FALSE, warning = FALSE}

x <- 37 + 12
print(x)

```

L’option echo permet d’afficher (ou pas) le code dans le document généré, et l’option warning permet d’afficher (ou non) les avertissements générés par le code en sortie. Voici la liste des principales options disponibles :

Option Valeurs Description
echo TRUE/FALSE Afficher ou non le code R dans le document en sortie
eval TRUE/FALSE Exécuter ou non le code R durant la compilation du R Markdown
include TRUE/FALSE Inclure ou non le code R et ses résultats dans le document
warning TRUE/FALSE Afficher ou non les avertissements générés par le code du chunk
message TRUE/FALSE Afficher ou non les messages générés par le code du chunk

L’ensemble des options disponibles sont décrites dans le guide de référence R Markdown, et également dans plusieurs références listées ci-dessous.

3.4 Documentation de référence

Pour en savoir plus, pour se former au R Markdown et à la syntaxe markdown :

4 La rédaction d’une fiche

Les auteur.e.s sont libres dans le choix de la problématique et dans la façon d’articuler le contenu de leur fiche Rzine mais, afin d’assurer une certaine cohérence éditoriale et une qualité du contenu de la collection, les auteur.e.s sont soumis à quelques obligations.

4.1 Métadonnées d’en tête

Commencez par modifier l’en-tête du template readrzine (YAML header), en personnalisant le titre, le sous-titre, le nom de ou des auteur.es et les affiliations, comme par exemple :

---
title: "Analyse textuelle exploratoire"
subtitle: "Exploration d'un corpus de lettre avec le package Quanteda"
date: "2022-01-20"
author: 
 - name: Jeanne Dupont
   affiliation: UMR TEXTO, CNRS
 - name: Paul Edouard
   affiliation: Centre documentaire ED, Université de France


4.2 Le résumé

Il est obligatoire de proposer un résumé en début de publication. Ce résumé sera utilisé pour la page de présentation de la fiche (cf. exemple) sur le site rzine.fr, pour le dépôt Github du code source (cf. exemple), du DOI et le référencement sur HAL.

Ce résumé doit faire entre 250 à 800 caractères (espaces comprises). Il peut comprendre des informations sur d’éventuels prérequis pour bien comprendre le document.

Pour mettre en forme votre résumé en introduction de fiche, utilisez le symbol “>” qui permet de créer un bloc de citation qui apparaîtra sur un fond gris. Exemple :

> Ce document... xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx

> **Prérequis** : xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx

Le bloc de citation apparaîtra comme suit :

Ce document… xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx

Prérequis : xx x xx x xx xxx xxxx xx xx xxxx x xx x xxx xxxx x xx xxx xxxx xx xx xxxx x xx x xxx


4.3 Contextualisation

Il est essentiel et obligatoire d’introduire et de contextualiser le contenu de votre document.

Vous pouvez pour cela vous appuyer sur des références bibliographiques, utiles pour les non-spécialistes de la thématique ou de la méthode présentée (cf. partie 4.10).


4.4 Données utilisées

4.4.1 Conditions d’utilisation

Pour assurer le reproductibilité complète de la fiche, les données utilisées doivent obligatoirement être mises à disposition des lecteur·rice·s. Pour ne pas empêcher la diffusion publique et libre de la fiche, vous ne pouvez pas utiliser de données soumises à des restrictions de diffusion et d’utilisation publiques.

4.4.2 Présentation

Les données doivent être directement présentées, sourcées et brièvement décrites dans la fiche (cf.exemple). Consacrez-y un chapitre ou sous-chapitre en fonction de leurs spécificités.

4.4.3 Mise à disposition

Même si les données mobilisées sont déjà librement mises à disposition, il est obligatoire de les sauvegarder dans votre répertoire et de les rendre directement téléchargeables depuis la fiche.

Pour cela :

  1. Copiez votre (ou vos) fichier(s) de données dans le sous-répertoire “data”.

  2. Remplissez le fichier metadata.md (Markdown) situé à la racine, avec toutes les métadonnées nécessaires et obligatoires. Ce fichier doit contenir toutes les informations utiles pour comprendre et retrouver ces données à la source.

  3. Ajoutez un bouton de téléchargement des données dans votre fiche, en copiant-collant ce bout de code HTML :

<br/>

<p class="center">[<span style="font-size: 230%;" class="glyphicon glyphicon-download-alt"></span><br/>Télécharger les données](https://rzine.fr/docs/...../data.zip)</p>

<br/>

Voici le rendu :



Télécharger les données



4.5 Packages et fonctions

Comme pour les données, il est important de consacrer un sous-chapitre aux packages utilisés. Tous les packages mobilisés pour l’analyse doivent être listés et décrits (cf. exemple) :
- package1 : description…
- package2 : description…
- package3 : description…

Tous les packages et fonctions explicitement nommés doivent également être mis en page de cette façon :

`packages` et `fonction()`

Voici le rendu : packages et fonction()


4.6 Illustration

4.6.1 Illustration de couverture

Le template readrzine permet l’affichage d’une illustration en couverture.

Le format optimal de cette image de couverture est de type “bandeau” (ex : 750 x 300 pixels).

4.6.2 Image dans le corps du texte

Les images affichées dans le corps du texte doivent être stockées dans le répertoire “figures”. Il existe plusieurs solutions pour insérer des images dans un document R Markdown. Il est possible d’utiliser du code R dans un chunk, d’utiliser le langage Markdown ou HTML (recommandé).

Pour insérer une image en HTML :

<figure class="center">
  <img src="figures/rzine.png" width="200">
  
  <figcaption style="font-size:13px;">Logo de la collection Rzine, 2021,  [https://rzine.fr/collection/#collection](https://rzine.fr/collection/#collection){target="_blank"}</figcaption>

</figure>

Cela affichera l’image centrée et large de 200 pixels, ainsi qu’un titre (source) :

Logo de la collection Rzine, 2021, https://rzine.fr/collection/#collection



4.7 Ecriture de code R

Le code R présenté dans la fiche doit être indenté, espacé et commenté. Il est demandé aux auteur·e·s de prendre soin de la syntaxe et de respecter les principales conventions d’écriture.

Pour en savoir plus, vous pouvez consulter The tidyverse style guide d’Hadley Wickham.


4.8 Message d’alerte

Il est possible d’utiliser certains messages d’alerte boostrap :

  • Encadré vert (success) : pour mettre en avant une information
  • Encadré rouge (danger) : our mettre en relief une information primordiale

La syntaxe HTML à utiliser est :

<div class="alert alert-success" role="alert">Message d'information</div>

**ET**
 
<div class="alert alert-danger" role="alert">Message <b>très important</b></div>

Voici le rendu :

ET


4.9 Formules mathématiques

Il est possible d’écrire des formules mathématiques en langage \(\TeX\). Il suffit de délimiter le contenu \(\LaTeX\) par un ou deux symboles $, ex :

$$ y = \sqrt{\frac{1}{x + \beta}} $$ 

En mode Inline (un seul $) , les formules sont incluses à l’intérieur du paragraphe courant, ex : \(\sum_{i=1}^n X_i\)
En mode Displayed (deux $), elles apparaissent centrées et mises en exergue, ex : \[ y = \sqrt{\frac{1}{x + \beta}} \]


4.10 Références bibliographiques

Le template readrzine intègre automatiquement une section de références bibliographiques. Il est fortement recommandé aux auteur·e·s de l’utiliser. Cependant cette section n’est pas obligatoire, vous pouvez supprimer les lignes suivantes dans le fichier index.rmd si vous ne souhaitez pas afficher de bibliographie :

# Bibliographie {-}

<div id="refs"></div>

Sinon, pour ajouter des références bibliographiques, complétez le fichier biblio.bib.

Trois références bibliographiques sont saisies par défaut dans le fichier biblio.bib :

@Manual{R-base,
  title = {R: A Language and Environment for Statistical Computing},
  author = {{R Core Team}},
  organization = {R Foundation for Statistical Computing},
  address = {Vienna, Austria},
  year = {2020},
  url = {https://www.R-project.org/},
}

@Manual{R-knitr,
  title = {knitr: A General-Purpose Package for Dynamic Report Generation in R},
  author = {Yihui Xie},
  year = {2020},
  note = {R package version 1.28},
  url = {https://CRAN.R-project.org/package=knitr},
}

@Manual{R-rmdformats,
  title = {rmdformats: HTML Output Formats and Templates for 'rmarkdown' Documents},
  author = {Julien Barnier},
  year = {2021},
  note = {R package version 1.0.2},
  url = {https://github.com/juba/rmdformats},
}

Beaucoup de documentation sur les fichiers BibTex sont consultables sur internet (exemple). Supprimez et ajoutez les références bibliographiques que vous souhaitez.


4.11 Glossaire

Cette section n’est pas obligatoire, cependant vos lecteur.rices ne seront pas forcément issu·es de votre discipline ou ne maîtriseront peut-être pas la thématique ou méthode présentée. En définissant certains termes utilisés, la section « Glossaire » permet de rendre la démonstration compréhensible à un public plus large.

Pour ajouter un mot ou expression, ainsi que sa définition dans le Glossaire, utilisez la syntaxe markdown suivante :

texte texte texte mot à définir^[__Mot à définir__: Définition du terme... ]

A la compilation du document en format HTML, un numéro est automatiquement associé et affiché après le “mot à définir”. Ce mot/expression et sa définition sont ajoutés dans la section « Glossaire ». Exemple : Mot à définir1

Si vous ne souhaitez pas utiliser de Glossaire, supprimez les lignes suivantes dans le fichier index.rmd :

## Glossaire {- #endnotes}

```{js, echo=FALSE}

$(document).ready(function() {
  $('.footnotes ol').appendTo('#endnotes');
  $('.footnotes').remove();
});

```


<br/>


4.12 Informations sur la session

Cette section obligatoire est directement intégrée au template.

## Info session  {-}

```{r session_info, echo=FALSE}
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[1]], row.names = F))
kableExtra::kable_styling(knitr::kable(rzine::sessionRzine()[[2]], row.names = F))
```

Ce bout de code affiche des informations sur la session qui a permis de générer la fiche (système d’exploitation, versions de R et des packages utilisés). Voir l’exemple pour ce document.


4.13 Citation BibTex

Cette section obligatoire est directement intégrée au template.

## Citation {-}

```{r Citation, echo=FALSE}

rref <- bibentry(
   bibtype = "article",
   title = "Titre de la fiche",
   author = person("Auteur.e 1", "Auteur.e 2" ),
   journal = "Rzine.fr",
   publisher = "FR CIST",
   year = 2021,
   url = "https://...")

``` 

`r capture.output(print(rref))`

### BibTex : {-}

```{r generateBibTex, echo=FALSE}

writeLines(toBibtex(rref), "cite.bib")
toBibtex(rref)

``` 


<br/>

Ne mofifiez pas cette section, elle sera complétée avant publication par l’équipe éditoriale. Ces deux chunks permettent l’affichage de la référence bibliographique de votre fiche dans le corps du document (Voir l’exemple pour ce document), ainsi que le stockage de cette référence en format BibTex, enregistrée dans le fichier cite.bib à la racine du répertoire.

5 La soumission d’une fiche

Une fois que le fichier index.Rmd est rédigé et qu’il a été compilé en format HTML (knit), vérifiez que les annexes (biblio.bib, featured.png, figures et data) ont été complétées, remplacées ou supprimées.

Vous êtes alors en mesure de soumettre votre travail au comité de lecture Rzine. Pour cela, vous devez :

1) Déposer votre travail sur un dépôt Git (logiciel de gestion de versions décentralisé).
2) Déployer la fiche en format HTML depuis le dépôt GitHub pour la rendre consultable en ligne.
3) Contacter le comité de lecture en lui fournissant l’adresse du dépôt.


5.1 Premiers pas sur Github

Le logiciel de gestion de versions décentralisé que vous devez utiliser pour la soumission est GitHub.

5.1.1 Création de compte

Commencez par vous connecter à la page de création de compte GitHub.

Saisissez le courriel que vous souhaitez utiliser, un mot de passe, un nom d’utilisateur et répondez aux questions de sécurité pour créer votre compte. Un code de sécurité vous sera envoyé au courriel renseigné afin de valider la création du compte.

5.1.2 Création d’un dépôt

Vous avez désormais un compte GitHub. Cliquez surStart a project” ou “Create repositorypour créer un dépôt qui hébergera votre fiche.

Vous pouvez également créer un nouveau dépôt en cliquant sur “+” puis “New repository” en haut à droite de la fenêtre :

Un fois sur la page de création d’un nouveau dépôt, saisissez un nom de dépôt (sans espaces ni caractères spéciaux) et éventuellement une description. Initialisez ce dépôt comme Public et demandez l’ajout automatique d’un fichier README.md :

Puis cliquez sur “Create repository”. Votre dépôt, uniquement rempli d’un fichier README.md, a été créé :


5.2 Remplissage du dépôt

Vous pouvez désormais y ajouter le répertoire (et sous-répertoires) contenant tous les fichiers de votre fiche. Il existe plusieurs méthodes pour téléverser des fichiers sur GitHub (en ligne de commande ou en clic-bouton). Nous présentons ici la méthode clic-bouton depuis l’interface de GitHub.

Cliquez sur “Add file”, puis sur “Upload files” :.


Ajoutez un commentaire et cliquez surCommit changes” :

Vous venez de réaliser votre premiercommit” (enregistrement des changements). L’ensemble des fichiers est désormais stocké sur le dépôt :

Ce dépôt étant paramétré comme public, tout le monde peut désormais le consulter et récupérer les fichiers qu’il contient.


5.3 Déploiement de la fiche

Les fichiers sont consultables à l’état brut, mais une manipulation supplémentaire va permettre de mettre en ligne votre fiche (format HTML). Votre fiche mise en forme sera ainsi consultable par tout le monde sur le web, sans avoir à gérer un serveur ou un site web.

5.3.1 GitHub Page

Dans le dépôt concerné, cliquez surSettings > Pages > Source (none)” et sélectionnez la branche “main” :


Ne modifiez pas le répertoire ciblé par défaut (root) et cliquez sursave:


Vous pouvez retrouver l’URL d’accès dans le menu “Settings > Pages” :

Cliquez sur le lien affiché pour consulter la fiche mise en ligne :

5.3.2 README.md

Le fichier markdown README.md est utilisé pour présenter les informations importantes à propos du dépôt. Son contenu est automatiquement affiché (et mis en forme grâce à la syntaxe markdown) sous les fichiers listés du dépôt.

Vous pouvez éditer et modifier facilement ce fichier depuis l’interface GitHub en cliquant sur le symbole crayon :

Vous pouvez alors personnaliser le fichier en modifiant : le titre, le sous-titre, le.s auteur.e.s (et affiliation.s), et l’URL de consultation de la fiche. Exemple :

Une fois les modifications terminées, commentez votre commit, puis cliquez sur Commit changes pour enregistrer les modifications :


5.4 Soumettre

Il ne vous reste plus qu’à contacter le comité de lecture Rzine pour soumettre votre fiche pour évaluation. Envoyez un courriel à collection[a]rzine.fr, en précisant l’adresse du dépôt qui héberge votre fiche.

Vous serez contacté·e par le comité de lecture dans les 15 jours suivants l’envoi de ce courriel.

6 Le processus de relecture

En cas d’acceptation, un ou une éditeur·rice désigné·e par la direction du comité de lecture prendra sous sa responsabilité le du processus de relecture.

Deux relecteur·rice·s doté·e·s des connaissances thématiques nécessaires seront proposé·e·s à l’auteur·e. Rzine est dans une démarche volontariste de science ouverte, la relecture des fiches Rzine est ouverte et transparente. L’identité des relecteur·rice·s et leurs retours sont publics.

Parce qu’une fiche est un document computationnel, l’ensemble du processus se déroule sur GitHub. Vous serez donc invité·e à ouvrir les droits du dépôt GitHub de votre fiche aux relecteur·rice·s désigné·e·s. Les retours (enrichissements, illustrations, corrections…) se feront se feront directement sur la plateforme GitHub via des issues.


7 Question ?

Pour toute question relative au processus de soumission et de relecture d’une fiche, vous pouvez contacter le comité de lecture à l’adresse collection[a]rzine.fr.

Bibliographie

BARNIER, Julien, 2021. rmdformats: HTML Output Formats and Templates for ’rmarkdown’ Documents [en ligne]. S.l. : s.n. Disponible à l'adresse : https://github.com/juba/rmdformats.
R CORE TEAM, 2020. R: A Language and Environment for Statistical Computing [en ligne]. Vienna, Austria : R Foundation for Statistical Computing. Disponible à l'adresse : https://www.R-project.org/.
XIE, Yihui, 2020. knitr: A General-Purpose Package for Dynamic Report Generation in R [en ligne]. S.l. : s.n. Disponible à l'adresse : https://CRAN.R-project.org/package=knitr.

Annexes

Info session

setting value
version R version 4.1.2 (2021-11-01)
os Windows 10 x64 (build 22000)
system x86_64, mingw32
ui RTerm
language (EN)
collate French_France.1252
ctype French_France.1252
tz Europe/Paris
date 2022-01-20
pandoc 2.14.0.3 @ C:/Program Files/RStudio/bin/pandoc/ (via rmarkdown)
package ondiskversion source
kableExtra 1.3.4 CRAN (R 4.1.2)
knitr 1.37 CRAN (R 4.1.2)

Citation

Rzine (2021). “Publier une fiche Rzine.” doi: 10.48645/xxxxxx (URL:, https://doi.org/10.48645/xxxxxx), <URL:, https://rzine.fr/publication_rzine/xxxxxxx/>.

BibTex :

@Misc{,
  title = {Publier une fiche Rzine},
  subtitle = {Processus de rédaction, soumission et relecture d’une fiche Rzine},
  author = {{Rzine}},
  doi = {10.48645/xxxxxx},
  url = {https://rzine.fr/publication_rzine/xxxxxxx/},
  keywords = {FOS: Other social sciences},
  language = {fr},
  publisher = {FR2007 CIST},
  year = {2021},
  copyright = {Creative Commons Attribution Share Alike 4.0 International},
}


Glossaire


  1. Mot à définir: Définition du terme à définir… ect.↩︎